reticle.py

Go to the documentation of this file.

# -*- coding: utf-8 -*-
"""
...\PTVR_Researchers\Python_Scripts\Demos\Pointing\reticle.py
 
Goal of this demo: 
        Show the simplest way of creating a standard PTVR 
        contingent reticle.
        In this demo, the reticle is head-contingent (i.e. it moves with
        your head) - this is also known as being head-controlled.
        
            
Note 1 :    By default, the reticle is White. This is perfect when the 
        (average) background is dark (as in the present demo.
            If the (average) background were luminous, you could 
        set the reticle's color to black 
        (cf. 'color 'parameter in ReticleImageFromDrawing() )
        
Note 2:  If the background is dark in some locations and bright in other 
        locations, the best choice is to use the BICOLOR RETICLE by 
        setting the 'two_colors' parameter to True in ReticleImageFromDrawing().
       The BICOLOR reticle is made of two contours (white and black),
        which makes it ideal for a background containing dark and bright patches
        of colors.
        
        To illustrate the use of the BICOLOR RETICLE, have a look at the
        "reticle_on_different_bckgnd_colors.py" demo.
        
Note 3: The reticle belongs to the PTVR category called "flat cursors". 
 
 
"""
 
from PTVR.Visual import The3DWorld
from PTVR.Stimuli.Scenes import VisualScene
from PTVR.Pointing.PointingCursor import *
import PTVR.Pointing.ReticleImageFromDrawing as RG
from PTVR.SystemUtils import LaunchThe3DWorld
 
my_contingency = ImageContingency.HEADSET
 
my_world = The3DWorld()
 
def main():
 
    my_scene = VisualScene (skybox = "Night")  # "Night", "BrightMorning", "Cloudy", 
                                            # "Afternoon", "Sunset"
 
    reticle_2D_image = RG.ReticleImageFromDrawing()    
    
    # If you want to open a window on your PC showing the reticle image
    # that has just been internally drawn, comment out the following line.
    # reticle_2D_image.Show()
 
    # transform 'reticle_2D_image' into a contingent cursor.
    my_reticle = ImageToContingentCursor(
        image = reticle_2D_image,
        contingency_type = my_contingency)
 
    my_scene.place_contingent_cursor(my_reticle)
 
    my_world.add_scene(my_scene)
    my_world.write()
 
if __name__ == "__main__":
    main()
    LaunchThe3DWorld()  # Launch the Experiment with PTVR.